<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ssl_stream::async_handshake (2 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../index.html" title="Chapter 1. Boost.Beast">
<link rel="up" href="../async_handshake.html" title="ssl_stream::async_handshake">
<link rel="prev" href="overload1.html" title="ssl_stream::async_handshake (1 of 2 overloads)">
<link rel="next" href="../shutdown.html" title="ssl_stream::shutdown">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_handshake.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../shutdown.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="beast.ref.boost__beast__ssl_stream.async_handshake.overload2"></a><a class="link" href="overload2.html" title="ssl_stream::async_handshake (2 of 2 overloads)">ssl_stream::async_handshake
          (2 of 2 overloads)</a>
</h6></div></div></div>
<p>
            Start an asynchronous SSL handshake.
          </p>
<h7><a name="beast.ref.boost__beast__ssl_stream.async_handshake.overload2.h0"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_handshake.overload2.synopsis"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__ssl_stream.async_handshake.overload2.synopsis">Synopsis</a>
          </h7><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">class</span> <a href="../../../../../../../../doc/html/boost_asio/reference/ConstBufferSequence.html" target="_top"><span class="emphasis"><em>ConstBufferSequence</em></span></a><span class="special">,</span>
    <span class="keyword">class</span> <span class="identifier">BufferedHandshakeHandler</span><span class="special">&gt;</span>
<a href="../../../../../../../../doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type" target="_top"><span class="emphasis"><em>DEDUCED</em></span></a>
<span class="identifier">async_handshake</span><span class="special">(</span>
    <span class="identifier">handshake_type</span> <span class="identifier">type</span><span class="special">,</span>
    <span class="identifier">ConstBufferSequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">,</span>
    <span class="identifier">BOOST_ASIO_MOVE_ARG</span><span class="special">(</span><span class="identifier">BufferedHandshakeHandler</span><span class="special">)</span> <span class="identifier">handler</span><span class="special">);</span>
</pre>
<h7><a name="beast.ref.boost__beast__ssl_stream.async_handshake.overload2.h1"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_handshake.overload2.description"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__ssl_stream.async_handshake.overload2.description">Description</a>
          </h7><p>
            This function is used to asynchronously perform an SSL handshake on the
            stream. This function call always returns immediately.
          </p>
<h7><a name="beast.ref.boost__beast__ssl_stream.async_handshake.overload2.h2"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_handshake.overload2.parameters"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__ssl_stream.async_handshake.overload2.parameters">Parameters</a>
          </h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Name
                    </p>
                  </th>
<th>
                    <p>
                      Description
                    </p>
                  </th>
</tr></thead>
<tbody>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">type</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The type of handshaking to be performed, i.e. as a client or
                      as a server.
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">buffers</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The buffered data to be reused for the handshake. Although
                      the buffers object may be copied as necessary, ownership of
                      the underlying buffers is retained by the caller, which must
                      guarantee that they remain valid until the handler is called.
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">handler</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The handler to be called when the handshake operation completes.
                      Copies will be made of the handler as required. The equivalent
                      function signature of the handler must be:
                    </p>
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"> <span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
  <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">error</span><span class="special">,</span> <span class="comment">// Result of operation.</span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span> <span class="comment">// Amount of buffers used in handshake.</span>
<span class="special">);</span>
</pre>
                  </td>
</tr>
</tbody>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
      Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_handshake.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../shutdown.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
